# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Pokemon Ranger (Quest) Template

game: Pokemon Ranger (Quest)
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Pokemon Ranger (Quest): 1.0.3 # Version of the world required for this yaml to work as expected.

Pokemon Ranger (Quest):
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  quest_count:
    # Sets the number of quests that are shuffled as items into the item pool.
    # 
    # Allowed values are actually in range 1 to 1000.
    # However, special values like "random" will only roll values up to 200 and software like the Option Creator
    #     will only allow you to choose values up to 200.
    # If you want any value above 200, you will have to edit your yaml in a text editor.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 200
    20: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-200: 0 # random value between 1 and 200

  goal_amount:
    # Sets the number quests needed to goal (including the "Inspect a pokemon" check).
    # It cannot be higher than **Quest Count**.
    # It also actually accepts values up to 1000.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 200
    20: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-200: 0 # random value between 1 and 200

  modify_quest_pool:
    # Modifies what type of quests are allowed as items to be shuffled into the multiworld's item pool.
    # 
    # The following is an example for how this option can look like:
    # ```
    # modify_quest_pool:
    #     ["Captures (off-mission)", "Poké Assists"]
    # ```
    # Here is an alternative way to format it:
    # ```
    # modify_quest_pool:
    #     - Captures (off-mission)
    #     - Poké Assists
    # ```
    # 
    # You can add as many of the following modifiers as you want.
    # However, at least one modifier is always required.
    # - **Captures (off-mission)** - Quests for capturing a specific (non-legendary) pokemon species,
    #     that can be caught at any time on a completed save file.
    # - **Captures (missions-only)** - Quests for capturing a specific pokemon species, that can only be caught
    #     during story missions. Requires starting a new save file or continuing an incomplete save file.
    # - **Legendary captures (off-mission)** - Quests for capturing a specific legendary(!) pokemon species,
    #     that can be caught at any time on a completed save file.
    # - **Captures (special missions)** - Quests for capturing either Deoxys, Celebi, or Mew
    #     (which can only be caught during special missions outside of your save file).
    # - **Poké Assists** - Quests for using a specific type of Poke Assist while capturing another pokemon.
    ['Captures (off-mission)', 'Poké Assists']

  duplicate_quests:
    # Allows quests to appear more than once in the item pool. Otherwise, every item will be unique.
    # 
    # However, if you set **Quest Count** higher than the actual available amount of quests,
    #     duplicate quests will inevitably be added regardless of this option.
    'false': 50
    'true': 0

  captures_blacklist:
    # Prevents these pokemon from having a capture quests shuffled into the item pool.
    []

  quest_plando:
    # Ensures that these quests will be put into the item pool at least as many times as specified.
    # Ignores **Modify Quest Pool** and **Captures Blacklist**.
    # 
    # The following is an example for how this option can look like:
    # ```
    # quest_plando:
    #     {"Capture a Zigzagoon": 1, "Use a Fire type Poké Assist": 5}
    # ```
    # Here is an alternative way to format it:
    # ```
    # quest_plando:
    #     Capture a Zigzagoon: 1
    #     Use a Fire type Poké Assist: 5
    # ```
    # 
    # However, if you add more quests to this option than what you set in **Quest Count**,
    #     only a random slice of this option is put into the item pool.
    {}

  force_one_check_at_a_time:
    # Forces every action in-game to check only one quest at a time.
    # Otherwise, having duplicate quests active at the same time will check all of them at the same time when completed.
    'false': 50
    'true': 0

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
